<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class openSSO_Abstract</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class openSSO_Abstract</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|													<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
                <p class="implements">
            Implements interfaces:
            <ul>
                <li><a href="../OpenSSO_PHP/openSSO_API.html">openSSO_API</a></li>            </ul>
        </p>
        		<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">abstract:</span> </li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_open-sso.abstract.php.html">/open-sso.abstract.php</a> (line <span class="field">20</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../OpenSSO_PHP/openSSO.html">openSSO</a></td>
					<td>
											
										</td>
				</tr>
							</table>
		</div>
	</div>



	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																																																												
												<div class="method-definition">
											<span class="method-result">openSSO_Abstract</span>
										<a href="#openSSO_Abstract" title="details" class="method-name">openSSO_Abstract</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">openSSO_Abstract</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#__destruct" title="details" class="method-name">__destruct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">(multi)</span>
										<a href="#getSessionData" title="details" class="method-name">getSessionData</a>
											(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">(array|bool|multi)</span>
										<a href="#getUserData" title="details" class="method-name">getUserData</a>
											([<span class="var-type">(string)</span>&nbsp;<span class="var-name">$dataName</span> = <span class="var-default">''</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#hookError" title="details" class="method-name">hookError</a>
											(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">(bool)</span>
										<a href="#hookIsError" title="details" class="method-name">hookIsError</a>
											(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#hookLogin" title="details" class="method-name">hookLogin</a>
											(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#hookLogout" title="details" class="method-name">hookLogout</a>
											(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#http" title="details" class="method-name">http</a>
											(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#https" title="details" class="method-name">https</a>
											(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#insertUser" title="details" class="method-name">insertUser</a>
											(<span class="var-type">(array)</span>&nbsp;<span class="var-name">$data</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">(bool)</span>
										<a href="#isHttps" title="details" class="method-name">isHttps</a>
											(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">(bool)</span>
										<a href="#isLogin" title="details" class="method-name">isLogin</a>
											(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#logIn" title="details" class="method-name">logIn</a>
											(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#logOut" title="details" class="method-name">logOut</a>
											(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">(array)</span>
										<a href="#selectUser" title="details" class="method-name">selectUser</a>
											(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$userName</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setSessionData" title="details" class="method-name">setSessionData</a>
											(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">(multi)</span>&nbsp;<span class="var-name">$value</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setUserData" title="details" class="method-name">setUserData</a>
											(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$data</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#trigger" title="details" class="method-name">trigger</a>
											([<span class="var-type">(string)</span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">''</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#updateUser" title="details" class="method-name">updateUser</a>
											(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$userName</span>, <span class="var-type">(array)</span>&nbsp;<span class="var-name">$data</span>)
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodopenSSO_Abstract" id="openSSO_Abstract"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor openSSO_Abstract</span> (line <span class="line-number">164</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">PHP4 constructor</p>
<p class="description"><p>PHP4 constructor</p></p>
	
	<div class="method-signature">
		<span class="method-result">openSSO_Abstract</span>
		<span class="method-name">
			openSSO_Abstract
		</span>
				()
			</div>
	
		
			
	</div>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">241</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">PHP5 constructor.</p>
<p class="description"><p>PHP5 constructor. Use the PHP4 constructor.</p></p>
	
	<div class="method-signature">
		<span class="method-result">openSSO_Abstract</span>
		<span class="method-name">
			__construct
		</span>
				()
			</div>
	
		
			
	</div>
<a name="method__destruct" id="__destruct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Destructor __destruct</span> (line <span class="line-number">250</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">PHP5 destructor</p>
<p class="description"><p>PHP5 destructor</p></p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			__destruct
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetSessionData" id="getSessionData"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getSessionData</span> (line <span class="line-number">33</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get data from the session.</p>
<p class="description"><p>Get data from the session.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Value of the data.</li>
				<li><span class="field">abstract:</span> </li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">(multi)</span>
		<span class="method-name">
			getSessionData
		</span>
					(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">(string)</span>
				<span class="var-name">$name</span><span class="var-description">: Name of the data.</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../OpenSSO_PHP/openSSO.html#methodgetSessionData">openSSO::getSessionData()</a>
								: Get data from the session
							</li>
				</ul>
	</div>
<a name="methodgetUserData" id="getUserData"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getUserData</span> (line <span class="line-number">841</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the user's data.</p>
<p class="description"><p>Get the user's data. Logged in usage only.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The value of the user's data. If '$dataName' is empty return a single array with all of         the data. If '$dataName' is invalid return (bool)FALSE. Use 'sso_' prefix to access the user's SSO data.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">(array|bool|multi)</span>
		<span class="method-name">
			getUserData
		</span>
					([<span class="var-type">(string)</span>&nbsp;<span class="var-name">$dataName</span> = <span class="var-default">''</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">(string)</span>
				<span class="var-name">$dataName</span><span class="var-description">: The name of the user's data. Use 'sso_' prefix to access the user's SSO data.</span>			</li>
				</ul>
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_API.html#methodgetUserData">openSSO_API::getUserData()</a></dt>
						<dd>Get the user's data.</dd>
					</dl>
			
	</div>
<a name="methodhookError" id="hookError"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">hookError</span> (line <span class="line-number">130</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Hook: Error Call this function when the IDP or the SP is down.</p>
<p class="description"><p>Hook: Error Call this function when the IDP or the SP is down.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			hookError
		</span>
					(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">void</span>
				<span class="var-name">0</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../OpenSSO_PHP/openSSO.html#methodhookError">openSSO::hookError()</a>
								: Hook: Error Call this function when the IDP or the SP is down.
							</li>
				</ul>
	</div>
<a name="methodhookIsError" id="hookIsError"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">hookIsError</span> (line <span class="line-number">121</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Hook: Is Error? Call this function to determine that error is occured or not.</p>
<p class="description"><p>Hook: Is Error? Call this function to determine that error is occured or not.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> 'TRUE' if error is occured and 'FALSE' otherwise.</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">(bool)</span>
		<span class="method-name">
			hookIsError
		</span>
					(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">void</span>
				<span class="var-name">0</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../OpenSSO_PHP/openSSO.html#methodhookIsError">openSSO::hookIsError()</a>
								: Hook: Is Error? Call this function to determine that error is occured or not.
							</li>
				</ul>
	</div>
<a name="methodhookLogin" id="hookLogin"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">hookLogin</span> (line <span class="line-number">102</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Hook: Login Call this function after the lib checked the required user data, and created the session.</p>
<p class="description"><p>Hook: Login Call this function after the lib checked the required user data, and created the session. (Call this function after the login method.)</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			hookLogin
		</span>
					(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">void</span>
				<span class="var-name">0</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../OpenSSO_PHP/openSSO.html#methodhookLogin">openSSO::hookLogin()</a>
								: Hook: Login Call this function after the lib checked the required user data, and created the session.
							</li>
				</ul>
	</div>
<a name="methodhookLogout" id="hookLogout"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">hookLogout</span> (line <span class="line-number">112</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Hook: Logout Call this function after the lib &quot;destroy&quot; the session.</p>
<p class="description"><p>Hook: Logout Call this function after the lib &quot;destroy&quot; the session. (Call this function after the logout method.)</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			hookLogout
		</span>
					(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">void</span>
				<span class="var-name">0</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../OpenSSO_PHP/openSSO.html#methodhookLogout">openSSO::hookLogout()</a>
								: Hook: Logout Call this function after the lib &quot;destroy&quot; the session.
							</li>
				</ul>
	</div>
<a name="methodhttp" id="http"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">http</span> (line <span class="line-number">467</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get HTTP connection, not HTTPS.</p>
<p class="description"><p>Get HTTP connection, not HTTPS. If the user request this 'page' with SSL (HTTPS) this function redirect to the non secured version of the 'page' (HTTP). For example: https://example.org/dir/file.php?var=1 redirect to http://example.org/dir/file.php?var=1</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			http
		</span>
					(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">void</span>
				<span class="var-name">0</span>			</li>
				</ul>
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_API.html#methodhttp">openSSO_API::http()</a></dt>
						<dd>Get HTTP connection, not HTTPS.</dd>
					</dl>
			
	</div>
<a name="methodhttps" id="https"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">https</span> (line <span class="line-number">449</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get HTTPS connection, not HTTP.</p>
<p class="description"><p>Get HTTPS connection, not HTTP. If the user request this 'page' without SSL (HTTP) this function redirect to the secured version of the 'page' (HTTPS). For example: http://example.org/dir/file.php?var=1 redirect to https://example.org/dir/file.php?var=1</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			https
		</span>
					(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">void</span>
				<span class="var-name">0</span>			</li>
				</ul>
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_API.html#methodhttps">openSSO_API::https()</a></dt>
						<dd>Get HTTPS connection, not HTTP.</dd>
					</dl>
			
	</div>
<a name="methodinsertUser" id="insertUser"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">insertUser</span> (line <span class="line-number">57</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Create user.</p>
<p class="description"><p>Create user. Create user with data from the '$data' param (user's SSO data). Insert to DB or whatever you store the users. Syntax: The data name that you setted in config file ('user' array) with 'sso_' prefix.	        Plus 'user_name', 'user_virid', 'user_groups' variables, and these with 'sso_' prefix.</p></p>
	<ul class="tags">
				<li><span class="field">abstract:</span> </li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			insertUser
		</span>
					(<span class="var-type">(array)</span>&nbsp;<span class="var-name">$data</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">(array)</span>
				<span class="var-name">$data</span><span class="var-description">: Single array of the user's SSO data. Keys represents the data name.</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../OpenSSO_PHP/openSSO.html#methodinsertUser">openSSO::insertUser()</a>
								: Create user.
							</li>
				</ul>
	</div>
<a name="methodisHttps" id="isHttps"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">isHttps</span> (line <span class="line-number">485</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Is secured, HTTPS connection?.</p>
<p class="description"><p>Is secured, HTTPS connection?. If the user request this 'page' without SSL (HTTP) this function redirect to the secured version of the 'page' (HTTPS). For example: http://example.org/dir/file.php?var=1 redirect to https://example.org/dir/file.php?var=1</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> TRUE if is a HTTPS connection and FALSE is a HTTP connection.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">(bool)</span>
		<span class="method-name">
			isHttps
		</span>
					(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">void</span>
				<span class="var-name">0</span>			</li>
				</ul>
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_API.html#methodisHttps">openSSO_API::isHttps()</a></dt>
						<dd>Is secured, HTTPS connection?.</dd>
					</dl>
			
	</div>
<a name="methodisLogin" id="isLogin"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">isLogin</span> (line <span class="line-number">776</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Is the user logged in?.</p>
<p class="description"><p>Is the user logged in?. Look after in session that the user is logged in or not.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> TRUE if the user logged in and FALSE if not.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">(bool)</span>
		<span class="method-name">
			isLogin
		</span>
					(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">void</span>
				<span class="var-name">0</span>			</li>
				</ul>
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_API.html#methodisLogin">openSSO_API::isLogin()</a></dt>
						<dd>Is the user logged in?</dd>
					</dl>
			
	</div>
<a name="methodlogIn" id="logIn"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">logIn</span> (line <span class="line-number">631</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Login the SSO user.</p>
<p class="description"><p>Login the SSO user. Use these function in your login page.
 WARNING: This function is can't garantee that the user logged in! You can always use the 'isLogin();' function after this function to check that the user really logged in.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			logIn
		</span>
					(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">void</span>
				<span class="var-name">0</span>			</li>
				</ul>
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_API.html#methodlogIn">openSSO_API::logIn()</a></dt>
						<dd>Login the SSO user.</dd>
					</dl>
			
	</div>
<a name="methodlogOut" id="logOut"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">logOut</span> (line <span class="line-number">685</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Logout the SSO user.</p>
<p class="description"><p>Logout the SSO user. Use these function in your logout page.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			logOut
		</span>
					(<span class="var-type">void</span>&nbsp;<span class="var-name">0</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">void</span>
				<span class="var-name">0</span>			</li>
				</ul>
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_API.html#methodlogOut">openSSO_API::logOut()</a></dt>
						<dd>Logout the SSO user.</dd>
					</dl>
			
	</div>
<a name="methodselectUser" id="selectUser"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">selectUser</span> (line <span class="line-number">69</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the user's data.</p>
<p class="description"><p>Get the user's data. Select user where the user name is equal with the '$userName' param. Read from DB or whatever you store the users. Return with all of the data that you store to this user (SSO and none SSO data). You must return the data names that the program add when the data stored (insert, update)!</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Single array of the user's data (SSO and none SSO). Keys represents the data name.</li>
				<li><span class="field">abstract:</span> </li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">(array)</span>
		<span class="method-name">
			selectUser
		</span>
					(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$userName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">(string)</span>
				<span class="var-name">$userName</span><span class="var-description">: The unique user name.</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../OpenSSO_PHP/openSSO.html#methodselectUser">openSSO::selectUser()</a>
								: Get the user's data.
							</li>
				</ul>
	</div>
<a name="methodsetSessionData" id="setSessionData"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setSessionData</span> (line <span class="line-number">45</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set data to the session.</p>
<p class="description"><p>Set data to the session. Set the '$value' data to the session with '$name' name. If this name exists overwrite it. If this name don't exists create it.</p></p>
	<ul class="tags">
				<li><span class="field">abstract:</span> </li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setSessionData
		</span>
					(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">(multi)</span>&nbsp;<span class="var-name">$value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">(string)</span>
				<span class="var-name">$name</span><span class="var-description">: Name of the data.</span>			</li>
					<li>
				<span class="var-type">(multi)</span>
				<span class="var-name">$value</span><span class="var-description">: Value of the data.</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../OpenSSO_PHP/openSSO.html#methodsetSessionData">openSSO::setSessionData()</a>
								: Set data to the session.
							</li>
				</ul>
	</div>
<a name="methodsetUserData" id="setUserData"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setUserData</span> (line <span class="line-number">882</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the user's data.</p>
<p class="description"><p>Set the user's data. Store user's data with 'updateUser();' function. Only accept none SSO data! Logged in usage only.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setUserData
		</span>
					(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$data</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">(string)</span>
				<span class="var-name">$data</span><span class="var-description">: Single array of the user's data. Keys represents the data name.</span>			</li>
				</ul>
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_API.html#methodsetUserData">openSSO_API::setUserData()</a></dt>
						<dd>Set the user's data.</dd>
					</dl>
			
	</div>
<a name="methodtrigger" id="trigger"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">trigger</span> (line <span class="line-number">761</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Trigger.</p>
<p class="description"><p>Trigger. These function create a simple redirect to the login page. Use these function in your trigger page. In default you shouldn't use these function. But if you should put trigger to another page than the default ('trigger.php'), you can do this with this function.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">example:</span> example not found</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			trigger
		</span>
					([<span class="var-type">(string)</span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">''</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">(string)</span>
				<span class="var-name">$url</span><span class="var-description">: The URL of the login page. If not setted redirect to the 'loginPage' config. If the this config                 also unsetted create a login action that equal with logIn(); function.</span>			</li>
				</ul>
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../OpenSSO_PHP/openSSO_API.html#methodtrigger">openSSO_API::trigger()</a></dt>
						<dd>Trigger.</dd>
					</dl>
			
	</div>
<a name="methodupdateUser" id="updateUser"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">updateUser</span> (line <span class="line-number">83</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Update user's data.</p>
<p class="description"><p>Update user's data. Update all (SSO and none SSO) user's data where the user name is equal with the '$userName' param. Update in DB or whatever you store the users. '$data' syntax: The data name that you setted in config file with 'sso_' prefix.                 Plus 'user_name', 'user_virid', 'user_groups' variables, and these with 'sso_' prefix.                 Plus your other data that added with 'setUserData();' function.</p></p>
	<ul class="tags">
				<li><span class="field">abstract:</span> </li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			updateUser
		</span>
					(<span class="var-type">(string)</span>&nbsp;<span class="var-name">$userName</span>, <span class="var-type">(array)</span>&nbsp;<span class="var-name">$data</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">(string)</span>
				<span class="var-name">$userName</span><span class="var-description">: The unique user name.</span>			</li>
					<li>
				<span class="var-type">(array)</span>
				<span class="var-name">$data</span><span class="var-description">: Single array of the user's data (SSO and none SSO). Keys represents the data name.</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../OpenSSO_PHP/openSSO.html#methodupdateUser">openSSO::updateUser()</a>
								: Update user's data.
							</li>
				</ul>
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 08 Jan 2010 00:36:00 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>